Generate a ZPK

Command:

Generate a random PIN key and return it to the Host encrypted under a ZMK for transmission to another party and under the LMK for storage on the Host database.

Notes:

If a 32-character ZMK is required, the HSM must be configured for double-length ZMKs using the CS (Configure Security) console command.

 

Field

Length  & Type

Details

COMMAND MESSAGE

Message header

m A

(Subsequently returned to the Host unchanged).

Command code

2 A

Value IA.

ZMK

16H or 32H or
1A+32H or 1A+48H

The ZMK encrypted under LMK pair 04-05.

Atalla variant

1 N or 2 N

Optional. Atalla variant; for use in systems with Atalla equipment.

Delimiter

1 A

Optional. If present the following three fields must be present.  Value “;”.

If an option is not required by the command fill with a valid value or 0.

Key scheme ZMK

1 A

Optional. Key scheme for encrypting key under ZMK.

Key scheme LMK

1 A

Optional. Key scheme for encrypting key under LMK.

Key check value type

1 A

Optional. Key check value calculation method

0 - KCV backwards compatible.

1 - KCV 6H.

End message delimiter

1 C

Optional. Must be present if a message trailer is present. Value X’19.

Message trailer

n A

Optional. Maximum length 32 characters. Maximum length 32 characters.

 


 

 Field

Length  & Type

Details

RESPONSE MESSAGE

Message header

m A

Returned to the Host unchanged.

Response code

2 A

Value IB.

Error code

2 N

00 : No errors

10 : ZMK does not have odd parity

12 : No keys loaded in user storage

13 : LMK error; report to supervisor

15 : Error in input data

21 : Invalid user storage index

ZPK under ZMK

16H or 1A+32H
or 1A+48H

The ZPK encrypted under the ZMK.

ZPK under LMK

16H or 1A+32H
or 1A+48H

The ZPK encrypted under LMK pair 06-07.

Check value

16 H or 6 H

Result of encrypting 64 binary zeroes with the ZPK.

16H or 6H depends upon KCV type option.

End message delimiter

1 C

Present only if present in the command message. Value X’19.

Message trailer

n A

Present only if present in the command message. Maximum length 32 characters.